Services Web de VoicePlan

VoiceCheck expose un service Web qui permet de créer un VoicePlan (essentiellement une importation de données). Ce service Web permet de créer des VoicePlans, de mettre à jour et de supprimer les VoicePlans existants du serveur VoiceCheck. Lorsque ce service Web est invoqué, VoiceCheck valide le système pour les opérations suivantes :

  • S'il n'existe aucun nom de VoicePlan correspondant, un nouveau VoicePlan est créé.
  • S'il existe un nom de VoicePlan correspondant, aucun nouveau VoicePlan n'est créé.
  • Un VoicePlan sans description, VoiceForm et étapes de la section est considéré comme non valide et il n'est pas créé.
  • Aucun VoicePlan n'est créé si le VoiceForm associé au VoicePlan est introuvable sur le serveur VoiceCheck.

Si VoiceCheck reçoit ce message pour la lecture, la mise à jour et la suppression de VoicePlans, les validations suivantes sont prises en compte :

  • Si le nom du VoicePlan n'existe pas dans VoiceCheck, aucun détail n'est renvoyé dans la réponse.
  • Si le VoicePlan existe, le service Web ne peut mettre à jour que le nom du VoicePlan.
  • Un VoicePlan peut être supprimé même s'il fait référence à une entité dans VoiceCheck.

Créer les détails d'un VoicePlan

Service Web REST

WADL : <http ou https>://<hôte>:<port>/VoiceCheck/services/voiceplan?_wadl

URL : <http ou https>://<hôte>:<port>/VoiceCheck/services/voiceplan

Méthode : POST

Content-Type : application/json;charset=UTF-8

Corps du message : JSON comme indiqué dans le schéma WADL Les éléments sont décrits dans le tableau des éléments d'entrée.

Réponse : en cas de succès, HTTP Status 200 avec Payload « VoicePlan enregistré ». En cas d'échec, le système renvoie une erreur. Tout code de statut HTTP autre que 200 ou 204 est considéré comme une erreur. Dans la mesure du possible, le système hôte doit renvoyer un corps pour les erreurs.

Paramètres POST

Un fichier VoicePlan avec des paramètres valides dans le corps.

LIRE LES DÉTAILS DU VoicePlan

SERVICE WEB REST

WADL : <http ou https>://<hôte>:<port>/VoiceCheck/services/voiceplan?_wadl

URL : <http ou https>://<hôte>:<port>/VoiceCheck/services/voiceplan/{planIdentifier}

Méthode : GET

Content-Type : application/json;charset=UTF-8

Réponse : en cas de succès, HTTP Status 200 avec ou sans corps. En cas d'échec, le système renvoie une erreur.

MISE À JOUR DES DÉTAILS DU VoicePlan

WADL : <http ou https>://<hôte>:<port>/VoiceCheck/services/voiceplan?_wadl

URL : <http ou https>://<hôte>:<port>/VoiceCheck/services/voiceplan/update/

Méthode : POST

Content-Type : application/json;charset=UTF-8

Réponse : en cas de succès, HTTP Status 200 avec ou sans corps. En cas d'échec, le système renvoie une erreur.

Paramètres POST

Un fichier VoicePlan avec des paramètres mis à jour dans le corps.

SUPPRIMER LES DÉTAILS DU VoicePlan

WADL : <http ou https>://<hôte>:<port>/VoiceCheck/services/voiceplan?_wadl

URL : <http ou https>://<hôte>:<port>/VoiceCheck/services/voiceplan/{planIdentifier}

Méthode : DELETE

Réponse : en cas de succès, HTTP Status 200 avec ou sans corps. En cas d'échec, le système renvoie une erreur.

ÉLÉMENTS D'ENTRÉE

PROPRIÉTÉ TYPE OBLIGATOIRE DÉFINITION VALIDATION
planIdentifier

Chaîne

Oui Nom du VoicePlan Doit être unique dans VoiceCheck